StockLocateResponse

V8 Message Definiton

StockLocateResponse records are either locates or rejections of locate requests. These records are clientFirm specific and are not shared. SpiderRock execution engines are aware of the locate quantities in StockLocateResponse records. Also, these records are shared and depricated accross all SpiderRock production environments.

METADATA

Attribute	Value
Topic	1725-client-borrow
MLink Token	ClientControl
Product	SRControl
accessType	SELECT

Table Definition

Field	Type	Key	Default Value	Comment
ticker_at	enum - AssetType	PRI	'None'
ticker_ts	enum - TickerSrc	PRI	'None'
ticker_tk	VARCHAR(12)	PRI	''
coreClientFirm	VARCHAR(16)	PRI	''
locateFirm	VARCHAR(6)	PRI	''	typically a clearing firm or 3rd party locate desk
locatePool	VARCHAR(16)	PRI	''	locate pool firm granting the locate
locateSource	enum - LocateSource	PRI	'None'
tradeDate	DATE	PRI	'1900-01-01'
locateID	VARCHAR(16)		''	ID used to make locate requests SR generated request ID if SR made the locate request client supplied otherwise
requestQuan	INT		0	original request quantity for requestID
locateQuan	INT		0
locateStatus	enum - LocateStatus		'None'
isLocateExempt	enum - YesNo		'None'	Yes ticker is locate exempt only allowed for market makers
altSecurityId	VARCHAR(12)		''	An alternative securityID can be cusip or other
requestOrigin	enum - RequestOrigin		'None'
requestTimestamp	DATETIME(6)		'1900-01-01 00:00:00.000000'
modifiedIn	enum - SysEnvironment		'None'
timestamp	DATETIME(6)		'1900-01-01 00:00:00.000000'

PRIMARY KEY DEFINITION (Unique)

Field	Sequence
ticker_tk	1
ticker_at	2
ticker_ts	3
coreClientFirm	4
locateFirm	5
locatePool	6
locateSource	7
tradeDate	8

CREATE TABLE EXAMPLE QUERY

CREATE TABLE `SRControl`.`MsgStockLocateResponse` (
    `ticker_at` ENUM('None','EQT','IDX','BND','CUR','COM','FUT','SYN','WAR','FLX','MUT','SPD','MM','MF','COIN','TOKEN','ANY') NOT NULL DEFAULT 'None',
    `ticker_ts` ENUM('None','SR','NMS','CME','ICE','CFE','CBOT','NYMEX','COMEX','RUT','CIDX','ARCA','NYSE','OTC','NSDQ','MFQS','MIAX','DJI','CUSIP','ISIN','BXE','EUX','ANY','CXE','DXE','NXAM','NXBR','NXLS','NXML','NXOS','NXP','EUREX','CEDX','ICEFE') NOT NULL DEFAULT 'None',
    `ticker_tk` VARCHAR(12) NOT NULL DEFAULT '',
    `coreClientFirm` VARCHAR(16) NOT NULL DEFAULT '',
    `locateFirm` VARCHAR(6) NOT NULL DEFAULT '' COMMENT 'typically a clearing firm (or 3rd party locate desk)',
    `locatePool` VARCHAR(16) NOT NULL DEFAULT '' COMMENT 'locate pool @ firm granting the locate',
    `locateSource` ENUM('None','Slate','AwaySRSE','AwayMLink','AwayTool') NOT NULL DEFAULT 'None',
    `tradeDate` DATE NOT NULL DEFAULT '1900-01-01',
    `locateID` VARCHAR(16) NOT NULL DEFAULT '' COMMENT 'ID used to make locate requests (SR generated request ID if SR made the locate request; client supplied otherwise)',
    `requestQuan` INT NOT NULL DEFAULT 0 COMMENT 'original request quantity for requestID',
    `locateQuan` INT NOT NULL DEFAULT 0,
    `locateStatus` ENUM('None','Queued','Submitted','SubmitError','Pending','FullOK','Partial','Rejected','CallDesk','Unknown') NOT NULL DEFAULT 'None',
    `isLocateExempt` ENUM('None','Yes','No') NOT NULL DEFAULT 'None' COMMENT 'Yes = ticker is locate exempt (only allowed for market makers)',
    `altSecurityId` VARCHAR(12) NOT NULL DEFAULT '' COMMENT 'An alternative securityID (can be cusip or other)',
    `requestOrigin` ENUM('None','SRSE','MLink','Tool','AwaySystem') NOT NULL DEFAULT 'None',
    `requestTimestamp` DATETIME(6) NOT NULL DEFAULT '1900-01-01 00:00:00.000000',
    `modifiedIn` ENUM('None','Neptune','Pluto','V7_Stable','V7_Latest','Saturn','Venus','Mars','SysTest','V7_Current') NOT NULL DEFAULT 'None',
    `timestamp` DATETIME(6) NOT NULL DEFAULT '1900-01-01 00:00:00.000000',
    PRIMARY KEY USING HASH (`ticker_tk`,`ticker_at`,`ticker_ts`,`coreClientFirm`,`locateFirm`,`locatePool`,`locateSource`,`tradeDate`)
) ENGINE=SRSE DEFAULT CHARSET=LATIN1 COMMENT='StockLocateResponse records are either locates or rejections of locate requests.  These records are clientFirm specific and are not shared.  SpiderRock execution engines are aware of the locate quantities in StockLocateResponse records.  Also, these records are shared and depricated accross all SpiderRock production environments.';

SELECT TABLE EXAMPLE QUERY

SELECT
    `ticker_at`,
    `ticker_ts`,
    `ticker_tk`,
    `coreClientFirm`,
    `locateFirm`,
    `locatePool`,
    `locateSource`,
    `tradeDate`,
    `locateID`,
    `requestQuan`,
    `locateQuan`,
    `locateStatus`,
    `isLocateExempt`,
    `altSecurityId`,
    `requestOrigin`,
    `requestTimestamp`,
    `timestamp`
FROM `SRControl`.`MsgStockLocateResponse`
WHERE 
    /* Replace with a ENUM('None','EQT','IDX','BND','CUR','COM','FUT','SYN','WAR','FLX','MUT','SPD','MM','MF','COIN','TOKEN','ANY') */ 
    `ticker_at` = 'None'
  AND
    /* Replace with a ENUM('None','SR','NMS','CME','ICE','CFE','CBOT','NYMEX','COMEX','RUT','CIDX','ARCA','NYSE','OTC','NSDQ','MFQS','MIAX','DJI','CUSIP','ISIN','BXE','EUX','ANY','CXE','DXE','NXAM','NXBR','NXLS','NXML','NXOS','NXP','EUREX','CEDX','ICEFE') */ 
    `ticker_ts` = 'None'
  AND
    /* Replace with a VARCHAR(12) */ 
    `ticker_tk` = 'Example_ticker_tk'
  AND
    /* Replace with a VARCHAR(16) */ 
    `coreClientFirm` = 'Example_coreClientFirm'
  AND
    /* Replace with a VARCHAR(6) */ 
    `locateFirm` = 'Example_locateFirm'
  AND
    /* Replace with a VARCHAR(16) */ 
    `locatePool` = 'Example_locatePool'
  AND
    /* Replace with a ENUM('None','Slate','AwaySRSE','AwayMLink','AwayTool') */ 
    `locateSource` = 'None'
  AND
    /* Replace with a DATE */
    `tradeDate` = '2022-01-01';

Doc Columns Query

SELECT * FROM SRControl.doccolumns WHERE TABLE_NAME='StockLocateResponse' ORDER BY ordinal_position ASC;